/*
 * Copyright 2002-2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.expression.spel.ast;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

import org.springframework.expression.EvaluationException;
import org.springframework.expression.TypedValue;
import org.springframework.expression.spel.ExpressionState;
import org.springframework.expression.spel.SpelNode;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
 * 1. InlineMap 表示什么
 * 		InlineMap 是 SpEL 表达式树中的一个节点类型，用来表示内联的 Map 文字。当解析器遇到类似 {key1: value1, key2: value2} 的语法时，会生成一个 InlineMap 节点。这个节点包含了所有键值对的信息，并且可以在表达式的上下文中被评估为一个实际的 Map 对象。
 *2. 具体使用例子
 *	 下面是一个具体的例子，展示了如何在 SpEL 表达式中使用内联 Map：
 *	 示例 1：基本用法
 * 		假设我们有一个简单的场景，想要根据用户的输入动态创建一个包含用户信息的 Map：
 *
 * 		public class InlineMapExample {
 *     		public static void main(String[] args) {
 *        		 // 创建解析器
 *        		 ExpressionParser parser = new SpelExpressionParser();
 *         		// 创建上下文
 *         		StandardEvaluationContext context = new StandardEvaluationContext();
 *
 *        		 // 定义内联 Map 的 SpEL 表达式
 *        		 String expression = "{ 'name': 'John Doe', 'age': 30 }";
 *
 *        		 // 解析并评估表达式
 *        		 Map<String, Object> userMap = parser.parseExpression(expression).getValue(context, Map.class);
 *
 *        		 System.out.println("User Info: " + userMap); // 输出: User Info: {name=John Doe, age=30}
 *    		 }
 * 		}
 *	在这个例子中，我们通过 SpEL 表达式 { 'name': 'John Doe', 'age': 30 } 创建了一个包含用户信息的 Map。这个 Map 包含两个键值对：一个是名字，另一个是年龄。
 *
 * 示例 2：结合变量使用
 * 		接下来，让我们看看如何结合变量来构建更复杂的表达式。我们可以将某些值作为变量传递给上下文，并在表达式中引用这些变量：
 *
 * 		public class InlineMapWithVariablesExample {
 *     		public static void main(String[] args) {
 *         		// 创建解析器
 *         		ExpressionParser parser = new SpelExpressionParser();
 *         		// 创建上下文并设置变量
 *         		StandardEvaluationContext context = new StandardEvaluationContext();
 *        		 context.setVariable("name", "Jane Smith");
 *        		 context.setVariable("age", 25);
 *
 *        		 // 定义内联 Map 的 SpEL 表达式，使用上下文中的变量
 *        		 String expression = "{ 'name': #name, 'age': #age, 'isAdult': #age >= 18 }";
 *
 *        		 // 解析并评估表达式
 *         		Map<String, Object> userMap = parser.parseExpression(expression).getValue(context, Map.class);
 *         		System.out.println("User Info: " + userMap); // 输出: User Info: {name=Jane Smith, age=25, isAdult=true}
 *    		 }
 * 		}
 *
 * 示例 3：嵌套内联 Map 和列表
 * 		你还可以创建更复杂的结构，例如嵌套的 Map 或者包含 Map 的列表
 *
 * 		public class NestedInlineMapAndListExample {
 *     		public static void main(String[] args) {
 *        		 // 创建解析器
 *        		 ExpressionParser parser = new SpelExpressionParser();
 *         		// 创建上下文
 *        		 StandardEvaluationContext context = new StandardEvaluationContext();
 *        		 // 定义复杂结构的 SpEL 表达式
 *        		 String expression = "{ 'user': { 'name': 'Alice', 'age': 30 }, 'preferences': ['reading', 'traveling'] }";
 *
 *        		 // 解析并评估表达式
 *        		 Map<String, Object> complexMap = parser.parseExpression(expression).getValue(context, Map.class);
 *        		 System.out.println("Complex Structure: " + complexMap);
 *       		  // 输出: Complex Structure: {user={name=Alice, age=30}, preferences=[reading, traveling]}
 *    		 }
 * 		}
 *
 * <br>
 *
 * Represent a map in an expression, e.g. '{name:'foo',age:12}'
 *<p>表示表达式中的映射，例如 '{name:'foo',age:12}'
 *
 * @author Andy Clement
 * @author Sam Brannen
 * @author Harry Yang
 * @since 4.1
 */
public class InlineMap extends SpelNodeImpl {

	@Nullable
	private final TypedValue constant;


	public InlineMap(int startPos, int endPos, SpelNodeImpl... args) {
		super(startPos, endPos, args);
		this.constant = computeConstantValue();
	}


	/**
	 * If all the components of the map are constants, or lists/maps that themselves
	 * contain constants, then a constant list can be built to represent this node.
	 * <p>This will speed up later getValue calls and reduce the amount of garbage
	 * created.
	 * <br> 如果 map 所有组件都是常量，或者列表/映射本身包含常量，则可以构建一个常量列表来表示此节点。
	 * <p>这将加快后续的 getValue 调用并减少垃圾的产生。
	 */
	@Nullable
	private TypedValue computeConstantValue() {
		for (int c = 0, max = getChildCount(); c < max; c++) {
			SpelNode child = getChild(c);
			if (!(child instanceof Literal)) {
				if (child instanceof InlineList inlineList) {
					if (!inlineList.isConstant()) {
						return null;
					}
				}
				else if (child instanceof InlineMap inlineMap) {
					if (!inlineMap.isConstant()) {
						return null;
					}
				}
				else if (!(c % 2 == 0 && child instanceof PropertyOrFieldReference)) {
					return null;
				}
			}
		}

		Map<Object, Object> constantMap = new LinkedHashMap<>();
		int childCount = getChildCount();
		for (int c = 0; c < childCount; c++) {
			//1、key
			SpelNode keyChild = getChild(c++);
			Object key;
			if (keyChild instanceof Literal literal) {
				key = literal.getLiteralValue().getValue();
			}
			else if (keyChild instanceof PropertyOrFieldReference propertyOrFieldReference) {
				key = propertyOrFieldReference.getName();
			}
			else {
				return null;
			}

			//2、 value ,value 所在位置 是 key所在位置的后一个位置，所以在获取key时，进行c++
			SpelNode valueChild = getChild(c);
			Object value = null;
			if (valueChild instanceof Literal literal) {
				value = literal.getLiteralValue().getValue();
			}
			else if (valueChild instanceof InlineList inlineList) {
				value = inlineList.getConstantValue();
			}
			else if (valueChild instanceof InlineMap inlineMap) {
				value = inlineMap.getConstantValue();
			}
			constantMap.put(key, value);
		}
		return new TypedValue(Collections.unmodifiableMap(constantMap));
	}

	@Override
	public TypedValue getValueInternal(ExpressionState expressionState) throws EvaluationException {
		if (this.constant != null) {
			return this.constant;
		}
		else {
			Map<Object, Object> returnValue = new LinkedHashMap<>();
			int childcount = getChildCount();
			for (int c = 0; c < childcount; c++) {
				SpelNode keyChild = getChild(c++);
				Object key = null;
				if (keyChild instanceof PropertyOrFieldReference reference) {
					key = reference.getName();
				}
				else {
					key = keyChild.getValue(expressionState);
				}
				Object value = getChild(c).getValue(expressionState);
				returnValue.put(key,  value);
			}
			return new TypedValue(returnValue);
		}
	}

	@Override
	public String toStringAST() {
		StringBuilder sb = new StringBuilder("{");
		int count = getChildCount();
		for (int c = 0; c < count; c++) {
			if (c > 0) {
				sb.append(',');
			}
			sb.append(getChild(c++).toStringAST());
			sb.append(':');
			sb.append(getChild(c).toStringAST());
		}
		sb.append('}');
		return sb.toString();
	}

	/**
	 * Return whether this map is a constant value.
	 */
	public boolean isConstant() {
		return this.constant != null;
	}

	@SuppressWarnings("unchecked")
	@Nullable
	public Map<Object, Object> getConstantValue() {
		Assert.state(this.constant != null, "No constant");
		return (Map<Object, Object>) this.constant.getValue();
	}

}
